/**
 * Copyright (c) 2010 by Kevin Bierhoff.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *    3. Neither the names of the authors nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHORS ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.googlecode.syper.javasyp.checker;

import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.Map;

import org.eclipse.jdt.core.dom.AST;
import org.eclipse.jdt.core.dom.ASTNode;
import org.eclipse.jdt.core.dom.ITypeBinding;
import org.eclipse.jdt.core.dom.IVariableBinding;

import com.googlecode.syper.javasyp.formulae.Field;
import com.googlecode.syper.javasyp.formulae.Formula;
import com.googlecode.syper.javasyp.formulae.Local;
import com.googlecode.syper.javasyp.formulae.Name;
import com.googlecode.syper.javasyp.prover.IFieldInfo;
import com.googlecode.syper.javasyp.prover.SmtLib;

/**
 * @author kevin
 * @since Jun 4, 2010
 */
public class HeapMapLogicMethodVisitor
extends AbstractLogicMethodVisitor<HeapMapHavocLookup>
implements IFieldInfo {

	@Override
	protected SmtLib createProver() {
		return new SmtLib(this, true);
	}

	@Override
	protected HeapMapHavocLookup createLookup(AST ast) {
		return new HeapMapHavocLookup(ast);
	}

	@Override
	protected  Collection<Field> getFieldsIfName(Formula rhs) {
		return Collections.emptySet();
	}

	@Override
	protected void havocUnprotected(ASTNode node,
			Map<Name, ? extends Collection<IVariableBinding>> modifiable) {
		if (getLookup() == null)
			// outside methods
			return;
		// TODO static methods?
		Local receiver = null;
		if (getReceiver() != null) {
			receiver = getLookup().getReceiver(getReceiver());
		}

		Map<Name, PermKind[]> keep = new LinkedHashMap<Name, PermKind[]>();
		if (isReceiverProtects())
			keep.put(receiver, PermKind.EMPTY_PERM_KIND_ARRAY);
		for (Map.Entry<Name, RefType> x :
			getCurrentScope().getRootsWithPermissions(getLookup()).entrySet())
		{
			Name o = x.getKey();
			ITypeBinding type = o.getType();
			if (type != null && type.isPrimitive())
				continue;
			if (o instanceof Field && receiver == null)
				continue;
			if (x.getValue() == null)
				continue;
			// TODO translate array access temps to Select formulae
			// o.isField() ? lookup.getField(receiver, o) : lookup.getLocal(o)
			keep.put(o, x.getValue().getElemDims());
		}
		// use havoc-except to err on forgetting
		assume(getLookup().havocHeap(keep, modifiable));
	}

	@Override
	public RefType getVariableType(IVariableBinding binding) {
		return getChecker().getVariableType(binding);
	}
}
